Skip to main content
Version: 1.0.0

Activity API

Activity API Overview

The Activity API allows developers to submit game-related activities to the Tribally platform. It provides a structured way to track and store activities, ensuring seamless integration with game ecosystems.

Table of Contents

Introduction

The Activity API is designed for partners who want to send structured game activity data to the Tribally platform. It enables applications to create and store activities related to in-game events, ensuring accurate tracking and seamless integration with reward systems.

Developers can submit a JSON object containing the activity details, which will be validated and stored upon successful processing.

Authentication

All requests to the Activity API require authentication using an API key. The x-api-key header must be included in every request to verify access permissions.

Example Authorization Header:

x-api-key: {your-api-key}

Error Handling

The API returns standard HTTP status codes to indicate the outcome of a request.

  • 400: Bad Request - The request contains invalid or missing parameters.
  • 401: Unauthorized - The request is missing a valid API key.
  • 500: Internal Server Error - An unexpected error occurred on the server.

Example Application

The Maze Game sends game activities to Tribally using the Activity API. This allows Maze Game players to complete quests and earn rewards!

Authentication

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer